/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.matching.rtp;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;

/**
   An RTP profile is stored in this class. The profile includes information
   regarding the rtp meeting the client is interested in, and the destination
   associated with this.

   @author Shrideep Pallickara
   $Revision$
   $Date$
 */

public class RtpProfile implements RtpMatchingDebugFlags {

  private long subscription;
  private int destinations;
  private String brokerDestination = null;
  private boolean includesBrokerInfo = false;
  private String moduleName = "RtpProfile: ";

  /** A RtpProfile is comprised of both the subscription as well as the
      destination of the unit/super-unit that has expressed an interest in it.
      @param subscription The rtp subscription
      @param destinations The hierarchial destinations associated with this
      rtpProfile */
  public RtpProfile(long subscription, int destinations) {
    this.subscription = subscription;
    this.destinations = destinations;
  }


  public RtpProfile(long subscription, String brokerDestination,
		    int destinations) {
    this.subscription = subscription;
    this.brokerDestination = brokerDestination;
    this.destinations = destinations;
    includesBrokerInfo = true;
  }

  /** This method serves to unmarshall a rtpProfile stream received over the
      link. The corresponding marshalling method for the rtpProfile is
      contained within the getBytes() method.
      @param rtpProfileBytes The marshalled stream of rtpProfile bytes that are
      received over a link. */
  public RtpProfile(byte[] rtpProfileBytes) {
    ByteArrayInputStream baInputStream =
      new ByteArrayInputStream(rtpProfileBytes);
    DataInputStream din = new DataInputStream(baInputStream);

    try {
      subscription = din.readLong();
      destinations = din.readInt();
      includesBrokerInfo = din.readBoolean();
      if (includesBrokerInfo)
	brokerDestination = din.readUTF();
    } catch(IOException ioe) {
      System.out.println(moduleName + "Error during unmarshalling " + ioe);
    } /* end try-catch */
  }

  /** This method returns the subscription associated with the rtpProfile.
      @return The subscription.
  */
  public long getSubscription() {
    return subscription;
  }

  /** This method returns the destinations assocaited with the subscription.
      @return The destinations.
  */
  public int getDestination() {
    return destinations;
  }

  public String getBrokerDestination() {
    return brokerDestination;
  }


  public String getProfileId() {
    /** The ID that is generated should be a unique one and should be
	reproducible anywhere. The method would return a null if such a
	unique ID generation isn't possible */
    if (includesBrokerInfo) {
      String rtpProfileId = brokerDestination + ":" + destinations +
	"[" + subscription + "]";
      return rtpProfileId;
    }
    return null;
  }

  /**
     Compares two objects for equality. Returns a boolean that indicates
     whether this object is equivalent to the specified object. This method
     is used when an object is stored in a hashtable.
     @param obj the Object to compare with
     @return true if these Objects are equal; false otherwise.
     @see java.util.Hashtable
  */
  public boolean equals(RtpProfile _rtpProfile) {
    if (subscription ==_rtpProfile.getSubscription() ) {
      return true;
    } else
      return false;
  }

  /**Generates a hash code for the receiver. This method is supported
     primarily for hash tables, such as those provided in java.util.
     If two objects are equal (equals(Object) returns true) they must have the
     same hash code
     @return an integer hash code for the receiver  */
//  public long hashCode() {
//    return subscription;
//  }

  /** This method returns the rtpProfile as a stream of bytes, the
      unmarshalling counterpart to this marshalling scheme is contained within
      one of the RtpProfile constructors
      @return The byte stream representation of the rtpProfile */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);

    try {
      dout.writeLong(subscription);
      dout.writeInt(destinations);
      dout.writeBoolean(includesBrokerInfo);
      if (includesBrokerInfo) {
	dout.writeUTF(brokerDestination);
      }
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error marshalling stream" + ioe);
    } /* end try-catch */
    return baOutputStream.toByteArray();
  }

  /** Provides a string representation of the rtpProfile instance.
      @return RtpProfile as a String object.
  */
  public String toString() {
    String info = "RtpProfile = [" + subscription +
      "] Destinations = [" + destinations + "Id = [" + getProfileId() + "]";
    return info;
  }


  public static void main(String[] args) {

  }

}
